Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update theme 1.8 #1081

Merged
merged 2 commits into from
Oct 8, 2024
Merged

Conversation

dgarcia360
Copy link
Contributor

Related issue scylladb/sphinx-scylladb-theme#1229

ScyllaDB Sphinx Theme 1.8 is out 🥳!
image

Here's a summary of changes:

  • Dark theme support for a fresh new look.
  • Updated branding assets including new logos and mascots.
  • Improved build process by recommending the inclusion of the poetry.lock file to ensure consistent dependencies in your CI/CD pipeline.
  • New tooltip component to add more context to glossary terms, configuration parameters, or any other elements without cluttering the page.

You can read more about all the notable changes here.

How to test this PR

  1. Clone this PR.

  2. Enter the docs folder, and run:

    make preview
    
  3. Open http://localhost:5500 in your browser. The doc should render without errors, and the version should be Sphinx Theme version (see the footer) must be 1.8.x:

    image

Copy link

github-actions bot commented Sep 29, 2024

cargo semver-checks found no API-breaking changes in this PR! 🎉🥳
Checked commit: 50963fb

@wprzytula wprzytula requested a review from Lorak-mmk September 30, 2024 10:11
@danielhe4rt
Copy link
Contributor

God bless!

Copy link
Collaborator

@Lorak-mmk Lorak-mmk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've successfully built the documentation. Dark theme looks awesome - code blocks have much better syntax highlighting than on light theme.

Is it possible to make the docs site respect browser preferences regarding theme? I have it set to "Dark" in firefox preferences, but it still opens light theme by default:
image

If not: is the default configurable somewhere? For Rust Driver docs can we change it to dark for better code block readability?

@dgarcia360
Copy link
Contributor Author

We'll work on making the docs site respect the system preferences in scylladb/sphinx-scylladb-theme#1231

@Lorak-mmk Lorak-mmk merged commit 4aa7305 into scylladb:main Oct 8, 2024
12 checks passed
@wprzytula wprzytula mentioned this pull request Nov 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants